Asset
Last updated
Was this helpful?
Last updated
Was this helpful?
Class used to manage all Asset functionality
‹UniqueIdentifiers, string›
↳ Asset
• compliance: Compliance
Protected context• context: Context
• did: string
Identity ID of the Asset (used for Claims)
• permissions: Permissions
• ticker: string
ticker of the Asset
• uuid: string
Force a transfer from a given Portfolio to the caller’s default Portfolio
Parameters:
args
opts?
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
Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created
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
▸ currentFundingRound(): Promise‹string | null›
Retrieve the Asset's funding round
note can be subscribed to
Returns: Promise‹string | null›
Parameters:
callback
Retrieve the Asset's data
note can be subscribed to
Parameters:
callback
▸ exists(): Promise‹boolean›
Determine whether this Asset exists on chain
Returns: Promise‹boolean›
Freeze transfers of the Asset
Parameters:
opts?
Retrieve the Asset's identifiers list
note can be subscribed to
Parameters:
callback?
Retrieve this Asset's Operation History
note Operations are grouped by the agent Identity who performed them
note uses the middleware
Retrieve this Asset's Operation History
note Operations are grouped by the agent Identity who performed them
note uses the middlewareV2
▸ 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›
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
▸ isFrozen(): Promise‹boolean›
Check whether transfers are frozen for the Asset
note can be subscribed to
Returns: Promise‹boolean›
Parameters:
callback
Modify some properties of the Asset
throws if the passed values result in no changes being made to the Asset
Parameters:
args
opts?
Assign a new primary issuance agent for the Asset
deprecated in favor of inviteAgent
Parameters:
args
opts?
Redeem (burn) an amount of this Asset's tokens
note tokens are removed from the caller's Default Portfolio
Parameters:
args
opts?
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?
â–¸ toHuman(): string
Return the Asset's ticker
Returns: string
Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient
Parameters:
args
opts?
Unfreeze transfers of the Asset
Parameters:
opts?
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
• assetHolders:
Defined in
• checkpoints:
Defined in
Defined in
Inherited from .
Defined in
• corporateActions:
Defined in
Defined in
• documents:
Defined in
• issuance:
Defined in
• offerings:
Defined in
Defined in
• settlements:
Defined in
Defined in
• transferRestrictions:
Defined in
Inherited from .
Defined in
▸ controllerTransfer(args: , opts?: ): Promise‹‹void››
Defined in
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
Returns: Promise‹‹void››
▸ createdAt(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
▸ createdAtV2(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
Defined in
▸ currentFundingRound(callback: ‹string | null›): Promise‹›
Defined in
‹string | null›
Returns: Promise‹›
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
▸ details(callback: ‹›): Promise‹›
Defined in
‹›
Returns: Promise‹›
Overrides .
Defined in
▸ freeze(opts?: ): Promise‹‹››
Defined in
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
Returns: Promise‹‹››
▸ getIdentifiers(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getIdentifiers(callback?: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
▸ getOperationHistory(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getOperationHistoryV2(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
▸ isFrozen(callback: ‹boolean›): Promise‹›
Defined in
‹boolean›
Returns: Promise‹›
▸ modify(args: , opts?: ): Promise‹‹››
Defined in
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
Returns: Promise‹‹››
▸ modifyPrimaryIssuanceAgent(args: , opts?: ): Promise‹‹void››
Defined in
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
Returns: Promise‹‹void››
▸ redeem(args: , opts?: ): Promise‹‹void››
Defined in
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
Returns: Promise‹‹void››
▸ removePrimaryIssuanceAgent(opts?: ): Promise‹‹void››
Defined in
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
Returns: Promise‹‹void››
Overrides .
Defined in
▸ transferOwnership(args: , opts?: ): Promise‹‹››
Defined in
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
Returns: Promise‹‹››
▸ unfreeze(opts?: ): Promise‹‹››
Defined in
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
Returns: Promise‹‹››
Inherited from .
Defined in
Inherited from .
Defined in