api_entities_Asset.Asset
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Asset
.Asset
Class used to manage all Asset functionality
<, string>
↳ Asset
Defined in
Defined in
Defined in
Defined in
• did: string
Identity ID of the Asset (used for Claims)
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• ticker: string
ticker of the Asset
Defined in
Defined in
• uuid: string
Inherited from
Defined in
â–¸ controllerTransfer(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Force a transfer from a given Portfolio to the caller’s default Portfolio
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
note uses the middleware
note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
Returns
Defined in
â–¸ currentFundingRound(): Promise<null | string>
Retrieve the Asset's funding round
note can be subscribed to
Returns
Promise<null | string>
Defined in
Parameters
callback
Returns
Defined in
Retrieve the Asset's data
note can be subscribed to
Returns
Defined in
Parameters
callback
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Asset exists on chain
Returns
Promise<boolean>
Overrides
Defined in
Freeze transfers of the Asset
Parameters
opts?
Returns
Defined in
Retrieve the Asset's identifiers list
note can be subscribed to
Returns
Defined in
Parameters
callback?
Returns
Defined in
Retrieve this Asset's Operation History
note Operations are grouped by the agent Identity who performed them
note uses the middleware
Returns
Defined in
â–¸ investorCount(): Promise<BigNumber>
Retrieve the amount of unique investors that hold this Asset
note this takes into account the Scope ID of Investor Uniqueness Claims. If an investor holds balances of this Asset in two or more different Identities, but they all have Investor Uniqueness Claims with the same Scope ID, then they will only be counted once for the purposes of this result
Returns
Promise<BigNumber>
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ isFrozen(): Promise<boolean>
Check whether transfers are frozen for the Asset
note can be subscribed to
Returns
Promise<boolean>
Defined in
Parameters
callback
Returns
Defined in
Modify some properties of the Asset
throws if the passed values result in no changes being made to the Asset
Parameters
args
opts?
Returns
Defined in
â–¸ modifyPrimaryIssuanceAgent(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Assign a new primary issuance agent for the Asset
deprecated in favor of inviteAgent
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ redeem(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Redeem (burn) an amount of this Asset's tokens
note tokens are removed from the caller's Default Portfolio
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ removePrimaryIssuanceAgent(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Remove the primary issuance agent of the Asset
note if primary issuance agent is not set, Asset owner would be used by default
deprecated
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ toHuman(): string
Return the Asset's ticker
Returns
string
Overrides
Defined in
Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient
Parameters
args
opts?
Returns
Defined in
Unfreeze transfers of the Asset
Parameters
opts?
Returns
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• assetHolders:
• checkpoints:
• compliance:
• corporateActions:
• documents:
• issuance:
• offerings:
• permissions:
• settlements:
• transferRestrictions:
.
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
â–¸ createdAt(): Promise<null | >
Promise<null | >
â–¸ currentFundingRound(callback): Promise<>
<null | string>
Promise<>
â–¸ details(): Promise<>
Promise<>
â–¸ details(callback): Promise<>
<>
Promise<>
.
â–¸ freeze(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ getIdentifiers(): Promise<[]>
Promise<[]>
â–¸ getIdentifiers(callback?): Promise<>
<[]>
Promise<>
â–¸ getOperationHistory(): Promise<[]>
Promise<[]>
<unknown, unknown>
.
â–¸ isFrozen(callback): Promise<>
<boolean>
Promise<>
â–¸ modify(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
note this will create an which has to be accepted by the target Identity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
.
â–¸ transferOwnership(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this will create which has to be accepted by the target Identity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
â–¸ unfreeze(opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
.
.