SecurityToken

Class used to manage all the Security Token functionality

Hierarchy

  • Entity‹UniqueIdentifiers›

    SecurityToken

Index

Properties

Methods

Properties

compliance

compliance: Compliance

Defined in src/api/entities/SecurityToken/index.ts:81

Protected context

context: Context

Inherited from Entity.context

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

did

did: string

Defined in src/api/entities/SecurityToken/index.ts:69

identity id of the Security Token

documents

documents: Documents

Defined in src/api/entities/SecurityToken/index.ts:77

issuance

issuance: Issuance

Defined in src/api/entities/SecurityToken/index.ts:80

settlements

settlements: Settlements

Defined in src/api/entities/SecurityToken/index.ts:78

ticker

ticker: string

Defined in src/api/entities/SecurityToken/index.ts:74

ticker of the Security Token

tokenHolders

tokenHolders: TokenHolders

Defined in src/api/entities/SecurityToken/index.ts:79

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

createdAt

createdAt(): Promise‹EventIdentifier | null›

Defined in src/api/entities/SecurityToken/index.ts:259

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›

Defined in src/api/entities/SecurityToken/index.ts:189

Retrieve the Security Token's funding round

note can be subscribed to

Returns: Promise‹string›

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

Defined in src/api/entities/SecurityToken/index.ts:190

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

details

details(): Promise‹SecurityTokenDetails

Defined in src/api/entities/SecurityToken/index.ts:134

Retrieve the Security Token's name, total supply, whether it is divisible or not and the Identity of the owner

note can be subscribed to

Returns: Promise‹SecurityTokenDetails

details(callback: SubCallbackSecurityTokenDetails›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/index.ts:135

Parameters:

Name

Type

callback

SubCallbackSecurityTokenDetails

Returns: Promise‹UnsubCallback

freeze

freeze(): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:286

Freezes transfers and minting of the Security Token

Returns: Promise‹TransactionQueueSecurityToken››

getIdentifiers

getIdentifiers(): Promise‹TokenIdentifier[]›

Defined in src/api/entities/SecurityToken/index.ts:223

Retrive the Security Token's asset identifiers list

note can be subscribed to

Returns: Promise‹TokenIdentifier[]›

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

Defined in src/api/entities/SecurityToken/index.ts:224

Parameters:

Name

Type

callback?

SubCallbackTokenIdentifier[]›

Returns: Promise‹UnsubCallback

isFrozen

isFrozen(): Promise‹boolean›

Defined in src/api/entities/SecurityToken/index.ts:304

Check whether transfers are frozen for the Security Token

note can be subscribed to

Returns: Promise‹boolean›

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

Defined in src/api/entities/SecurityToken/index.ts:305

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

modify

modify(args: ModifyTokenParams): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:124

Modify some properties of the Security Token

throws if the passed values result in no changes being made to the token

Parameters:

Name

Type

args

ModifyTokenParams

Returns: Promise‹TransactionQueueSecurityToken››

modifyPrimaryIssuanceAgent

modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/index.ts:342

Assign a new primary issuance agent for the Security Token

note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

Parameters:

Returns: Promise‹TransactionQueue‹void››

removePrimaryIssuanceAgent

removePrimaryIssuanceAgent(): Promise‹TransactionQueue‹void››

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

Remove the primary issuance agent of the Security Token

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

Returns: Promise‹TransactionQueue‹void››

transferOwnership

transferOwnership(args: TransferTokenOwnershipParams): Promise‹TransactionQueueSecurityToken››

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

Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary

note this will create Authorization Requests which have to be accepted by the corresponding Accounts and/or Identities. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

Parameters:

Returns: Promise‹TransactionQueueSecurityToken››

unfreeze

unfreeze(): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:294

Unfreeze transfers and minting of the Security Token

Returns: Promise‹TransactionQueueSecurityToken››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers: object

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers