Controller
Namespace that handles all Controller related functionality
Hierarchy
SubModule
↳ Controller
Index
Constructors
constructor
Properties
context
securityToken
Methods
disable
modifyController
redeem
signDisableAck
transfer
Constructors
constructor
+ new Controller(securityToken
: SecurityToken, context
: Context): Controller
Inherited from SubModule.constructor
Defined in src/entities/SecurityToken/SubModule.ts:10
Create a new SubModule instance
Parameters:
Returns: Controller
Properties
Protected
context
Protected
context• context: Context
Inherited from SubModule.context
Defined in src/entities/SecurityToken/SubModule.ts:10
Protected
securityToken
Protected
securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Defined in src/entities/SecurityToken/SubModule.ts:8
Methods
disable
▸ disable(args?
: undefined | object): Promise‹TransactionQueue‹DisableControllerProcedureArgs, void››
Defined in src/entities/SecurityToken/Controller.ts:33
Permanently disable controller functionality
Parameters:
Returns: Promise‹TransactionQueue‹DisableControllerProcedureArgs, void››
modifyController
▸ modifyController(args
: object): Promise‹TransactionQueue‹SetControllerProcedureArgs, void››
Defined in src/entities/SecurityToken/Controller.ts:20
Set the address of the Security Token's Controller. The controller may perform forced transfers
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹SetControllerProcedureArgs, void››
redeem
▸ redeem(args
: object): Promise‹TransactionQueue‹ControllerRedeemProcedureArgs, void››
Defined in src/entities/SecurityToken/Controller.ts:77
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
Returns: Promise‹TransactionQueue‹ControllerRedeemProcedureArgs, void››
signDisableAck
▸ signDisableAck(): Promise‹TransactionQueue‹SignDisableControllerAckProcedureArgs, void››
Defined in src/entities/SecurityToken/Controller.ts:95
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
Returns: Promise‹TransactionQueue‹SignDisableControllerAckProcedureArgs, void››
transfer
▸ transfer(args
: object): Promise‹TransactionQueue‹ControllerTransferProcedureArgs, void››
Defined in src/entities/SecurityToken/Controller.ts:49
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
Returns: Promise‹TransactionQueue‹ControllerTransferProcedureArgs, void››
Last updated