SecurityToken

Class used to manage all the Security Token functionality

Hierarchy

  • Entity‹UniqueIdentifiers›

    SecurityToken

Index

Properties

Methods

Properties

checkpoints

checkpoints: Checkpoints

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

compliance

compliance: Compliance

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

Protected context

context: Context

Inherited from CheckpointSchedule.context

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

corporateActions

corporateActions: CorporateActions

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

did

did: string

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

identity id of the Security Token

documents

documents: Documents

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

issuance

issuance: Issuance

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

offerings

offerings: Offerings

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

settlements

settlements: Settlements

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

ticker

ticker: string

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

ticker of the Security Token

tokenHolders

tokenHolders: TokenHolders

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

transferRestrictions

transferRestrictions: TransferRestrictions

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

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

controllerTransfer

controllerTransfer(args: ControllerTransferParams): Promise‹TransactionQueue‹void››

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

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

note required role:

  • Security Token Primary Issuance Agent

note this method is of type ProcedureMethod, which means you can call controllerTransfer.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

ControllerTransferParams

Returns: Promise‹TransactionQueue‹void››

createdAt

createdAt(): Promise‹EventIdentifier | null›

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

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

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

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

details

details(): Promise‹SecurityTokenDetails

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

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

Parameters:

Name

Type

callback

SubCallbackSecurityTokenDetails

Returns: Promise‹UnsubCallback

freeze

freeze(args: void): Promise‹TransactionQueueSecurityToken››

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

Freezes transfers and minting of the Security Token

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueueSecurityToken››

getIdentifiers

getIdentifiers(): Promise‹TokenIdentifier[]›

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

Retrieve 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:289

Parameters:

Name

Type

callback?

SubCallbackTokenIdentifier[]›

Returns: Promise‹UnsubCallback

investorCount

investorCount(): Promise‹number›

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

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

Parameters:

Name

Type

callback

SubCallback‹number›

Returns: Promise‹UnsubCallback

isEqual

isEqual(entity: Entity‹unknown›): boolean

Inherited from CheckpointSchedule.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown›

Returns: boolean

isFrozen

isFrozen(): Promise‹boolean›

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

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

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

modify

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

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

Modify some properties of the Security Token

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

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

ModifyTokenParams

Returns: Promise‹TransactionQueueSecurityToken››

modifyPrimaryIssuanceAgent

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

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

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

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

redeem

redeem(args: RedeemTokenParams): Promise‹TransactionQueue‹void››

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

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

note this method is of type ProcedureMethod, which means you can call redeem.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

RedeemTokenParams

Returns: Promise‹TransactionQueue‹void››

removePrimaryIssuanceAgent

removePrimaryIssuanceAgent(args: void): Promise‹TransactionQueue‹void››

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

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

note this method is of type ProcedureMethod, which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueue‹void››

transferOwnership

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

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

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

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueueSecurityToken››

unfreeze

unfreeze(args: void): Promise‹TransactionQueueSecurityToken››

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

Unfreeze transfers and minting of the Security Token

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueueSecurityToken››

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:

Name

Type

Description

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:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers