Class: FungibleAsset
api/entities/Asset/Fungible.FungibleAsset
Class used to manage all Fungible Asset functionality
Hierarchy
-
↳
FungibleAsset
Properties
assetHolders
• assetHolders: AssetHolders
Defined in
api/entities/Asset/Fungible/index.ts:49
checkpoints
• checkpoints: Checkpoints
Defined in
api/entities/Asset/Fungible/index.ts:53
compliance
• compliance: Compliance
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:71
corporateActions
• corporateActions: CorporateActions
Defined in
api/entities/Asset/Fungible/index.ts:54
did
• Optional did: string
Identity ID of the Asset (used for Claims)
Deprecated
this is no longer used from chain 7.x
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:81
documents
• documents: Documents
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:72
id
• id: string
Unique ID of the Asset in UUID format
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:95
issuance
• issuance: Issuance
Defined in
api/entities/Asset/Fungible/index.ts:50
metadata
• metadata: Metadata
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:73
offerings
• offerings: Offerings
Defined in
api/entities/Asset/Fungible/index.ts:52
permissions
• permissions: Permissions
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:74
settlements
• settlements: FungibleSettlements
Defined in
api/entities/Asset/Fungible/index.ts:48
ticker
• Optional ticker: string
ticker of the Asset
Since the chain version 7.x, ticker can be optionally associated with an Asset
Deprecated
in favour of ticker value received from the response of details method
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:90
transferRestrictions
• transferRestrictions: TransferRestrictions
Defined in
api/entities/Asset/Fungible/index.ts:51
uuid
• uuid: string
Inherited from
Defined in
Accessors
rawId
• get rawId(): string
Unique ID of the Asset in hex format
Returns
string
Note
Although UUID format is the usual representation of asset IDs, generic polkadot/substrate tools usually expect it in hex format
Inherited from
BaseAsset.rawId
Defined in
api/entities/Asset/Base/BaseAsset.ts:102
Methods
addRequiredMediators
▸ addRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Add required mediators. Mediators must approve any trades involving the asset
Parameters
| Name | Type |
|---|---|
args | AssetMediatorParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call addRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Inherited from
BaseAsset.addRequiredMediators
Defined in
api/entities/Asset/Base/BaseAsset.ts:265
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/Fungible/index.ts:148
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/Fungible/index.ts:86
currentFundingRound
▸ currentFundingRound(): Promise<null | string>
Retrieve the Asset's funding round
Returns
Promise<null | string>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:565
▸ currentFundingRound(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<null | string> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:566
details
▸ details(): Promise<AssetDetails>
Retrieve the Asset's data
Returns
Promise<AssetDetails>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:391
▸ details(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<AssetDetails> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:392
exists
▸ exists(): Promise<boolean>
Determine whether this FungibleAsset exists on chain
Returns
Promise<boolean>
Overrides
BaseAsset.exists
Defined in
api/entities/Asset/Fungible/index.ts:263
freeze
▸ freeze(opts?): Promise<GenericPolymeshTransaction<void, void>>
Freeze transfers of the Asset
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:245
getIdentifiers
▸ getIdentifiers(): Promise<SecurityIdentifier[]>
Retrieve the Asset's identifiers list
Returns
Promise<SecurityIdentifier[]>
Note
can be subscribed to, if connected to node using a web socket
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:311
▸ getIdentifiers(callback?): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback? | SubCallback<SecurityIdentifier[]> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:312
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/Fungible/index.ts:159
getRequiredMediators
▸ getRequiredMediators(): Promise<Identity[]>
Get required Asset mediators. These Identities must approve any Instruction involving the asset
Returns
Promise<Identity[]>
Inherited from
BaseAsset.getRequiredMediators
Defined in
api/entities/Asset/Base/BaseAsset.ts:510
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/Fungible/index.ts:190
getVenueFilteringDetails
▸ getVenueFilteringDetails(): Promise<VenueFilteringDetails>
Get venue filtering details
Returns
Promise<VenueFilteringDetails>
Inherited from
BaseAsset.getVenueFilteringDetails
Defined in
api/entities/Asset/Base/BaseAsset.ts:530
investorCount
▸ investorCount(): Promise<BigNumber>
Retrieve the amount of unique investors that hold this Asset
Returns
Promise<BigNumber>
Defined in
api/entities/Asset/Fungible/index.ts:119
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, if connected to node using a web socket
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:357
▸ isFrozen(callback): Promise<UnsubCallback>
Parameters
| Name | Type |
|---|---|
callback | SubCallback<boolean> |
Returns
Promise<UnsubCallback>
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:358
linkTicker
▸ linkTicker(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Link ticker to the asset
Parameters
| Name | Type |
|---|---|
args | LinkTickerToAssetParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
if ticker is already reserved, then required role:
- Ticker Owner
Note
this method is of type ProcedureMethod, which means you can call linkTicker.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/Asset/Base/BaseAsset.ts:288
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
Throws
if the passed assetType is not a known asset type or a custom type that has not been created on the chain
Throws
if trying to modify an NftCollection's assetType
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
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:151
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
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/Fungible/index.ts:112
removeRequiredMediators
▸ removeRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Remove required mediators
Parameters
| Name | Type |
|---|---|
args | AssetMediatorParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call removeRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Inherited from
BaseAsset.removeRequiredMediators
Defined in
api/entities/Asset/Base/BaseAsset.ts:275
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
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:127
toHuman
▸ toHuman(): string
Return the BaseAsset's ID
Returns
string
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:632
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
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:117
unfreeze
▸ unfreeze(opts?): Promise<GenericPolymeshTransaction<void, void>>
Unfreeze transfers of the Asset
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Inherited from
Defined in
api/entities/Asset/Base/BaseAsset.ts:255
unlinkTicker
▸ unlinkTicker(opts?): Promise<GenericPolymeshTransaction<void, void>>
Unlink ticker from the Asset
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
Only the ticker owner is allowed to unlink the Asset
Throws
if there is no ticker to unlink
Note
this method is of type NoArgsProcedureMethod, which means you can call unlinkTicker.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/Asset/Base/BaseAsset.ts:302
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