Class: Asset
api/entities/Asset.Asset
Class used to manage all Asset functionality
Hierarchy
-
Entity<UniqueIdentifiers,string>↳
Asset
Properties
assetHolders
• assetHolders: AssetHolders
Defined in
api/entities/Asset/index.ts:114
checkpoints
• checkpoints: Checkpoints
Defined in
api/entities/Asset/index.ts:119
compliance
• compliance: Compliance
Defined in
api/entities/Asset/index.ts:116
corporateActions
• corporateActions: CorporateActions
Defined in
api/entities/Asset/index.ts:120
did
• did: string
Identity ID of the Asset (used for Claims)
Defined in
api/entities/Asset/index.ts:104
documents
• documents: Documents
Defined in
api/entities/Asset/index.ts:112
issuance
• issuance: Issuance
Defined in
api/entities/Asset/index.ts:115
metadata
• metadata: Metadata
Defined in
api/entities/Asset/index.ts:122
offerings
• offerings: Offerings
Defined in
api/entities/Asset/index.ts:118
permissions
• permissions: Permissions
Defined in
api/entities/Asset/index.ts:121
settlements
• settlements: Settlements
Defined in
api/entities/Asset/index.ts:113
ticker
• ticker: string
ticker of the Asset
Defined in
api/entities/Asset/index.ts:109
transferRestrictions
• transferRestrictions: TransferRestrictions
Defined in
api/entities/Asset/index.ts:117
uuid
• uuid: string
Inherited from
Defined in
Methods
controllerTransfer
▸ controllerTransfer(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Force a transfer from a given Portfolio to the caller’s default Portfolio
Parameters
| Name | Type |
|---|---|
args | ControllerTransferParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call controllerTransfer.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:505
createdAt
▸ createdAt(): Promise<null | EventIdentifier>
Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
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/Asset/index.ts:388
currentFundingRound
▸ currentFundingRound(): Promise<null | string>
Retrieve the Asset's funding round
Returns
Promise<null | string>
Note
can be subscribed to
Defined in
api/entities/Asset/index.ts:314
▸ currentFundingRound(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<null | string> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/Asset/index.ts:315
details
▸ details(): Promise<AssetDetails>
Retrieve the Asset's data
Returns
Promise<AssetDetails>
Note
can be subscribed to
Defined in
api/entities/Asset/index.ts:214
▸ details(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback <AssetDetails> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/Asset/index.ts:215
exists
▸ exists(): Promise<boolean>
Determine whether this Asset exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/Asset/index.ts:602
freeze
▸ freeze(opts?): Promise<GenericPolymeshTransaction <Asset, Asset>>
Freeze transfers of the Asset
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction <Asset, Asset>>
Note
this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:412
getIdentifiers
▸ getIdentifiers(): Promise<SecurityIdentifier[]>
Retrieve the Asset's identifiers list
Returns
Promise<SecurityIdentifier[]>
Note
can be subscribed to
Defined in
api/entities/Asset/index.ts:351
▸ getIdentifiers(callback?): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback? | SubCallback <SecurityIdentifier[]> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/Asset/index.ts:352
getOperationHistory
▸ getOperationHistory(): Promise<HistoricAgentOperation[]>
Retrieve this Asset's Operation History
Returns
Promise<HistoricAgentOperation[]>
Note
Operations are grouped by the agent Identity who performed them
Note
uses the middlewareV2
Defined in
api/entities/Asset/index.ts:516
getTransactionHistory
▸ getTransactionHistory(opts): Promise<ResultSet <HistoricAssetTransaction>>
Retrieve this Asset's transaction History
Parameters
| Name | Type |
|---|---|
opts | Object |
opts.size? | BigNumber |
opts.start? | BigNumber |
Returns
Promise<ResultSet <HistoricAssetTransaction>>
Note
uses the middlewareV2
Defined in
api/entities/Asset/index.ts:545
investorCount
▸ investorCount(): Promise<BigNumber>
Retrieve the amount of unique investors that hold this Asset
Returns
Promise<BigNumber>
Defined in
api/entities/Asset/index.ts:475
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
isFrozen
▸ isFrozen(): Promise<boolean>
Check whether transfers are frozen for the Asset
Returns
Promise<boolean>
Note
can be subscribed to
Defined in
api/entities/Asset/index.ts:431
▸ isFrozen(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<boolean> |
Returns
Promise<UnsubCallback>
Defined in
api/entities/Asset/index.ts:432
modify
▸ modify(args, opts?): Promise<GenericPolymeshTransaction <Asset, Asset>>
Modify some properties of the Asset
Parameters
| Name | Type |
|---|---|
args | ModifyAssetParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction <Asset, Asset>>
Throws
if the passed values result in no changes being made to the Asset
Note
this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:205
redeem
▸ redeem(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Redeem (burn) an amount of this Asset's tokens
Parameters
| Name | Type |
|---|---|
args | RedeemTokensParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
tokens are removed from the caller's Default Portfolio
Note
this method is of type ProcedureMethod, which means you can call redeem.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:468
setVenueFiltering
▸ setVenueFiltering(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Enable/disable venue filtering for this Asset and/or set allowed/disallowed venues
Parameters
| Name | Type |
|---|---|
args | SetVenueFilteringParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call setVenueFiltering.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:625
toHuman
▸ toHuman(): string
Return the Asset's ticker
Returns
string
Overrides
Defined in
api/entities/Asset/index.ts:615
transferOwnership
▸ transferOwnership(args, opts?): Promise<GenericPolymeshTransaction <AuthorizationRequest, AuthorizationRequest>>
Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient
Parameters
| Name | Type |
|---|---|
args | TransferAssetOwnershipParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction <AuthorizationRequest, AuthorizationRequest>>
Note
this will create Authorization Request which has to be accepted by the target Identity.
An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived.
Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne
Note
this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:194
unfreeze
▸ unfreeze(opts?): Promise<GenericPolymeshTransaction <Asset, Asset>>
Unfreeze transfers of the Asset
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction <Asset, Asset>>
Note
this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/index.ts:422
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