Asset

Class used to manage all Asset functionality

Hierarchy

  • Entity‹UniqueIdentifiers, string›

    Asset

Index

Properties

Methods

Properties

assetHolders

assetHolders: AssetHolders

Defined in src/api/entities/Asset/index.ts:113


checkpoints

checkpoints: Checkpoints

Defined in src/api/entities/Asset/index.ts:118


compliance

compliance: Compliance

Defined in src/api/entities/Asset/index.ts:115


Protected context

context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48


corporateActions

corporateActions: CorporateActions

Defined in src/api/entities/Asset/index.ts:119


did

did: string

Defined in src/api/entities/Asset/index.ts:103

Identity ID of the Asset (used for Claims)


documents

documents: Documents

Defined in src/api/entities/Asset/index.ts:111


issuance

issuance: Issuance

Defined in src/api/entities/Asset/index.ts:114


offerings

offerings: Offerings

Defined in src/api/entities/Asset/index.ts:117


permissions

permissions: Permissions

Defined in src/api/entities/Asset/index.ts:120


settlements

settlements: Settlements

Defined in src/api/entities/Asset/index.ts:112


ticker

ticker: string

Defined in src/api/entities/Asset/index.ts:108

ticker of the Asset


transferRestrictions

transferRestrictions: TransferRestrictions

Defined in src/api/entities/Asset/index.ts:116


uuid

uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

controllerTransfer

controllerTransfer(args: ControllerTransferParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:549

Force a transfer from a given Portfolio to the caller’s default Portfolio

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

Parameters:

Returns: Promise‹TransactionQueue‹void››


createdAt

createdAt(): Promise‹EventIdentifier | null›

Defined in src/api/entities/Asset/index.ts:391

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: Promise‹EventIdentifier | null›


currentFundingRound

currentFundingRound(): Promise‹string | null›

Defined in src/api/entities/Asset/index.ts:316

Retrieve the Asset's funding round

note can be subscribed to

Returns: Promise‹string | null›

currentFundingRound(callback: SubCallback‹string | null›): Promise‹UnsubCallback

Defined in src/api/entities/Asset/index.ts:317

Parameters:

NameType

callback

SubCallback‹string | null›

Returns: Promise‹UnsubCallback


details

details(): Promise‹AssetDetails

Defined in src/api/entities/Asset/index.ts:215

Retrieve the Asset's data

note can be subscribed to

Returns: Promise‹AssetDetails

details(callback: SubCallbackAssetDetails›): Promise‹UnsubCallback

Defined in src/api/entities/Asset/index.ts:216

Parameters:

NameType

callback

Returns: Promise‹UnsubCallback


exists

exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/Asset/index.ts:641

Determine whether this Asset exists on chain

Returns: Promise‹boolean›


freeze

freeze(opts?: ProcedureOpts): Promise‹TransactionQueueAsset››

Defined in src/api/entities/Asset/index.ts:413

Freeze transfers and minting of the 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

Parameters:

NameType

opts?

Returns: Promise‹TransactionQueueAsset››


getIdentifiers

getIdentifiers(): Promise‹SecurityIdentifier[]›

Defined in src/api/entities/Asset/index.ts:354

Retrieve the Asset's identifiers list

note can be subscribed to

Returns: Promise‹SecurityIdentifier[]›

getIdentifiers(callback?: SubCallbackSecurityIdentifier[]›): Promise‹UnsubCallback

Defined in src/api/entities/Asset/index.ts:355

Parameters:

NameType

callback?

Returns: Promise‹UnsubCallback


getOperationHistory

getOperationHistory(): Promise‹HistoricAgentOperation[]›

Defined in src/api/entities/Asset/index.ts:560

Retrieve this Asset's Operation History

note Operations are grouped by the agent Identity who performed them

note uses the middleware

Returns: Promise‹HistoricAgentOperation[]›


investorCount

investorCount(): Promise‹BigNumber›

Defined in src/api/entities/Asset/index.ts:512

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

note can be subscribed to

Returns: Promise‹BigNumber›

investorCount(callback: SubCallback‹BigNumber›): Promise‹UnsubCallback

Defined in src/api/entities/Asset/index.ts:513

Parameters:

NameType

callback

SubCallback‹BigNumber›

Returns: Promise‹UnsubCallback


isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

NameType

entity

Entity‹unknown, unknown›

Returns: boolean


isFrozen

isFrozen(): Promise‹boolean›

Defined in src/api/entities/Asset/index.ts:432

Check whether transfers are frozen for the Asset

note can be subscribed to

Returns: Promise‹boolean›

isFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback

Defined in src/api/entities/Asset/index.ts:433

Parameters:

NameType

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback


modify

modify(args: ModifyAssetParams, opts?: ProcedureOpts): Promise‹TransactionQueueAsset››

Defined in src/api/entities/Asset/index.ts:206

Modify some properties of the 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

Parameters:

Returns: Promise‹TransactionQueueAsset››


modifyPrimaryIssuanceAgent

modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:473

Assign a new primary issuance agent for the Asset

note this will create an 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

deprecated in favor of inviteAgent

note this method is of type ProcedureMethod, which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››


redeem

redeem(args: RedeemTokensParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:499

Redeem (burn) an amount of this Asset's tokens

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

Parameters:

Returns: Promise‹TransactionQueue‹void››


removePrimaryIssuanceAgent

removePrimaryIssuanceAgent(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Asset/index.ts:487

Remove the primary issuance agent of the Asset

note if primary issuance agent is not set, Asset owner would be used by default

deprecated

note this method is of type NoArgsProcedureMethod, which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

NameType

opts?

Returns: Promise‹TransactionQueue‹void››


toJson

toJson(): string

Overrides Entity.toJson

Defined in src/api/entities/Asset/index.ts:654

Return the Asset's ticker

Returns: string


transferOwnership

transferOwnership(args: TransferAssetOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueueAuthorizationRequest››

Defined in src/api/entities/Asset/index.ts:195

Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient

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

Parameters:

Returns: Promise‹TransactionQueueAuthorizationRequest››


unfreeze

unfreeze(opts?: ProcedureOpts): Promise‹TransactionQueueAsset››

Defined in src/api/entities/Asset/index.ts:423

Unfreeze transfers and minting of the 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

Parameters:

NameType

opts?

Returns: Promise‹TransactionQueueAsset››


Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

NameTypeDescription

identifiers

Identifiers

Returns: string


Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

NameTypeDescription

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated