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:86

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:74

identity id of the Security Token

documents

documents: Documents

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

freeze

freeze: ProcedureMethod‹void, SecurityToken

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

Freezes transfers and minting of the Security Token

note required role:

  • Security Token Owner

issuance

issuance: Issuance

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

modify

modify: ProcedureMethod‹ModifyTokenParams, SecurityToken

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

Modify some properties of the Security Token

param makes an indivisible token divisible

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

note required role:

  • Security Token Owner

modifyPrimaryIssuanceAgent

modifyPrimaryIssuanceAgent: ProcedureMethod‹ModifyPrimaryIssuanceAgentParams, void›

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

Assign a new primary issuance agent for the Security Token

param identity to be set as primary issuance agent

param date at which the authorization request to modify the primary issuance agent expires (optional, never expires if a date is not provided)

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

note required role:

  • Security Token Owner

offerings

offerings: Offerings

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

redeem

redeem: ProcedureMethod‹RedeemTokenParams, void›

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

Redeem (burn) an amount of this Security Token

note Tokens are removed from the Primary Issuance Agent's Default Portfolio. If the Security Token has no Primary Issuance Agent, funds are removed from the owner's Default Portfolio instead

note required role:

  • Security Token Primary Issuance Agent

removePrimaryIssuanceAgent

removePrimaryIssuanceAgent: ProcedureMethod‹void, void›

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

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

note required role:

  • Security Token Owner

settlements

settlements: Settlements

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

ticker

ticker: string

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

ticker of the Security Token

tokenHolders

tokenHolders: TokenHolders

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

transferOwnership

transferOwnership: ProcedureMethod‹TransferTokenOwnershipParams, SecurityToken

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

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

param date at which the authorization request for transfer expires (optional)

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

note required role:

  • Security Token Owner

transferRestrictions

transferRestrictions: TransferRestrictions

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

unfreeze

unfreeze: ProcedureMethod‹void, SecurityToken

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

Unfreeze transfers and minting of the Security Token

note required role:

  • Security Token Owner

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:292

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:222

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:223

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

details

details(): Promise‹SecurityTokenDetails

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

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:165

Parameters:

Name

Type

callback

SubCallbackSecurityTokenDetails

Returns: Promise‹UnsubCallback

getIdentifiers

getIdentifiers(): Promise‹TokenIdentifier[]›

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

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:257

Parameters:

Name

Type

callback?

SubCallbackTokenIdentifier[]›

Returns: Promise‹UnsubCallback

investorCount

investorCount(): Promise‹number›

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

Retrieve the amount of unique investors that hold this Security Token

note this takes into account the Scope ID of Investor Uniqueness Claims. If an investor holds balances of this token 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‹number›

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

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

Parameters:

Name

Type

callback

SubCallback‹number›

Returns: Promise‹UnsubCallback

isFrozen

isFrozen(): Promise‹boolean›

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

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:338

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

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