Controller
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all Controller related functionality
↳ Controller
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Protected
contextProtected
securityTokenPermanently disable controller functionality
Parameters:
Name
Type
args?
undefined | object
Set the address of the Security Token's Controller. The controller may perform forced transfers
Parameters:
▪ args: object
Name
Type
controller
string
Redeem (burn) an amount of tokens from a token holder. Only the Security Token's controller can call this This operation is subject to transfer restrictions and the amount is limited by the token holder's balance. balanceOf(tokenHolder)
tokens) and potentially also need to respect other transfer restrictions.
Parameters:
▪ args: object
Name
Type
amount
BigNumber
data?
undefined | string
from
string
reason?
undefined | string
Generate a signature string that can be used to permanently disable the Security Token's controller functionality
Note that only the owner's signature is valid for this operation
Perform a forced transfer of tokens from one address to another. You must be the Security Token's controller to do this
Parameters:
▪ args: object
Name
Type
amount
BigNumber
data?
undefined | string
from
string
reason?
undefined | string
to
string
+ new Controller(securityToken
: , context
: ):
Inherited from .
Defined in
Returns:
• context:
Inherited from .
Defined in
• securityToken:
Inherited from .
Defined in
▸ disable(args?
: undefined | object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ modifyController(args
: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ redeem(args
: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ signDisableAck(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ transfer(args
: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››