SecurityToken

Class used to manage all the Security Token functionality

Hierarchy

• Entity‹Params›

  ↳ SecurityToken

Index

Constructors

• constructor

Properties

• address

• context

• controller

• currentCheckpoint

• dividends

• documents

• features

• granularity

• issuance

• name

• owner

• permissions

• symbol

• tokenDetails

• tokenholders

• totalSupply

• transfers

• treasuryWallet

• uid

• version

• unserialize

Methods

• _refresh

• toPojo

• transferOwnership

• generateId

Constructors

constructor

+ new SecurityToken(params: Params & UniqueIdentifiers, context: Context): SecurityToken

Defined in src/entities/SecurityToken/SecurityToken.ts:153

Create a new SecurityToken instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: SecurityToken

Properties

address

• address: string

Defined in src/entities/SecurityToken/SecurityToken.ts:114

address that owns the Security Token

context

• context: Context

Defined in src/entities/SecurityToken/SecurityToken.ts:153

controller

• controller: Controller

Defined in src/entities/SecurityToken/SecurityToken.ts:147

currentCheckpoint

• currentCheckpoint: number

Defined in src/entities/SecurityToken/SecurityToken.ts:130

index of the current checkpoint

dividends

• dividends: Dividends

Defined in src/entities/SecurityToken/SecurityToken.ts:141

documents

• documents: Documents

Defined in src/entities/SecurityToken/SecurityToken.ts:151

features

• features: Features

Defined in src/entities/SecurityToken/SecurityToken.ts:137

granularity

• granularity: number

Defined in src/entities/SecurityToken/SecurityToken.ts:123

issuance

• issuance: Issuance

Defined in src/entities/SecurityToken/SecurityToken.ts:143

name

• name: string

Defined in src/entities/SecurityToken/SecurityToken.ts:104

owner

• owner: string

Defined in src/entities/SecurityToken/SecurityToken.ts:109

address of the Security Token contract

permissions

• permissions: Permissions

Defined in src/entities/SecurityToken/SecurityToken.ts:145

symbol

• symbol: string

Defined in src/entities/SecurityToken/SecurityToken.ts:102

tokenDetails

• tokenDetails: string

Defined in src/entities/SecurityToken/SecurityToken.ts:119

URL pointing to off-chain data associated with the Security Token

tokenholders

• tokenholders: Tokenholders

Defined in src/entities/SecurityToken/SecurityToken.ts:139

totalSupply

• totalSupply: BigNumber

Defined in src/entities/SecurityToken/SecurityToken.ts:125

transfers

• transfers: Transfers

Defined in src/entities/SecurityToken/SecurityToken.ts:149

treasuryWallet

• treasuryWallet: string

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

treasury wallet used by some features

uid

• uid: string

Overrides Entity.uid

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

version

• version: Version

Defined in src/entities/SecurityToken/SecurityToken.ts:121

Static unserialize

▪ unserialize: unserialize = unserialize

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

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/SecurityToken/SecurityToken.ts:249

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

toPojo

▸ toPojo(): object

Overrides Entity.toPojo

Defined in src/entities/SecurityToken/SecurityToken.ts:216

Convert entity to a POJO (Plain Old Javascript Object)

Returns: object

• address: string

• currentCheckpoint: number

• granularity: number

• name: string

• owner: string

• symbol: string

• tokenDetails: string

• totalSupply: BigNumber

• treasuryWallet: string

• uid: string

• version: ContractVersion

transferOwnership

▸ transferOwnership(args: object): Promise‹TransactionQueue‹TransferOwnershipProcedureArgs, void››

Defined in src/entities/SecurityToken/SecurityToken.ts:202

Transfers ownership of the Security Token to a different wallet address

Parameters:

▪ args: object

Name	Type
newOwner	string

Returns: Promise‹TransactionQueue‹TransferOwnershipProcedureArgs, void››

Static generateId

▸ generateId(__namedParameters: object): string

Defined in src/entities/SecurityToken/SecurityToken.ts:92

Generate the Security Token's UUID from its identifying properties

Parameters:

▪ __namedParameters: object

Name	Type
symbol	string

Returns: string