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
Create a new SecurityToken instance
Parameters:
Name
Type
params
context
Returns: SecurityToken
Properties
address
• address: string
address that owns the Security Token
context
• context: Context
controller
• controller: Controller
currentCheckpoint
• currentCheckpoint: number
index of the current checkpoint
dividends
• dividends: Dividends
documents
• documents: Documents
features
• features: Features
granularity
• granularity: number
issuance
• issuance: Issuance
name
• name: string
owner
• owner: string
address of the Security Token contract
permissions
• permissions: Permissions
symbol
• symbol: string
tokenDetails
• tokenDetails: string
URL pointing to off-chain data associated with the Security Token
tokenholders
• tokenholders: Tokenholders
totalSupply
• totalSupply: BigNumber
transfers
• transfers: Transfers
treasuryWallet
• treasuryWallet: string
treasury wallet used by some features
uid
• uid: string
Overrides Entity.uid
version
• version: Version
Static unserialize
Static unserialize▪ unserialize: unserialize = unserialize
Methods
_refresh
▸ _refresh(params: Partial‹Params›): void
Overrides Entity._refresh
Hydrate the entity
Parameters:
Name
Type
params
Returns: void
toPojo
▸ toPojo(): object
Overrides Entity.toPojo
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››
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
Static generateId▸ generateId(__namedParameters: object): string
Generate the Security Token's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name
Type
symbol
string
Returns: string
Last updated
Was this helpful?