SecurityToken
Class used to manage all the Security Token functionality
Hierarchy
↳ SecurityToken
Index
Constructors
Properties
Methods
Constructors
constructor
Create a new SecurityToken instance
Parameters:
Properties
address
• address: string
address that owns the Security Token
context
controller
currentCheckpoint
• currentCheckpoint: number
index of the current checkpoint
dividends
documents
features
granularity
• granularity: number
issuance
name
• name: string
owner
• owner: string
address of the Security Token contract
permissions
symbol
• symbol: string
tokenDetails
• tokenDetails: string
URL pointing to off-chain data associated with the Security Token
tokenholders
totalSupply
• totalSupply: BigNumber
transfers
treasuryWallet
• treasuryWallet: string
treasury wallet used by some features
uid
• uid: string
version
• version: Version
Static
unserialize
Static
unserialize▪ unserialize: unserialize = unserialize
Methods
_refresh
Hydrate the entity
Parameters:
Returns: void
toPojo
▸ toPojo(): object
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
Transfers ownership of the Security Token to a different wallet address
Parameters:
▪ args: object
Static
generateId
Static
generateId▸ generateId(__namedParameters
: object): string
Generate the Security Token's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Returns: string
Last updated