SecurityToken
Last updated
Was this helpful?
Last updated
Was this helpful?
Class used to manage all the Security Token functionality
‹›
↳ SecurityToken
Create a new SecurityToken instance
Parameters:
Name
Type
params
context
• address: string
address that owns the Security Token
• currentCheckpoint: number
index of the current checkpoint
• granularity: number
• name: string
• owner: string
address of the Security Token contract
• symbol: string
• tokenDetails: string
URL pointing to off-chain data associated with the Security Token
• totalSupply: BigNumber
• treasuryWallet: string
treasury wallet used by some features
• uid: string
• version: Version
Static unserializeâ–ª unserialize: unserialize = unserialize
Hydrate the entity
Parameters:
Name
Type
params
Returns: void
â–¸ 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
Transfers ownership of the Security Token to a different wallet address
Parameters:
â–ª args: object
Name
Type
newOwner
string
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
+ new SecurityToken(params: & , context: ):
Defined in
&
Returns:
Defined in
• context:
Defined in
• controller:
Defined in
Defined in
• dividends:
Defined in
• documents:
Defined in
• features:
Defined in
Defined in
• issuance:
Defined in
Defined in
Defined in
• permissions:
Defined in
Defined in
Defined in
• tokenholders:
Defined in
Defined in
• transfers:
Defined in
Defined in
Overrides .
Defined in
Defined in
Defined in
▸ _refresh(params: Partial‹›): void
Overrides .
Defined in
Partial‹›
Overrides .
Defined in
▸ transferOwnership(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Defined in