Controller

Namespace that handles all Controller related functionality

Hierarchy

Index

Constructors

Properties

Methods

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:

Name

Type

securityToken

context

Returns: Controller

Properties

Protected context

context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

Protected securityToken

securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

disable

disable(args?: undefined | object): Promise‹TransactionQueueDisableControllerProcedureArgs, void››

Defined in src/entities/SecurityToken/Controller.ts:33

Permanently disable controller functionality

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹TransactionQueueDisableControllerProcedureArgs, void››

modifyController

modifyController(args: object): Promise‹TransactionQueueSetControllerProcedureArgs, 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

Name

Type

controller

string

Returns: Promise‹TransactionQueueSetControllerProcedureArgs, void››

redeem

redeem(args: object): Promise‹TransactionQueueControllerRedeemProcedureArgs, 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

Name

Type

amount

BigNumber

data?

undefined | string

from

string

reason?

undefined | string

Returns: Promise‹TransactionQueueControllerRedeemProcedureArgs, void››

signDisableAck

signDisableAck(): Promise‹TransactionQueueSignDisableControllerAckProcedureArgs, 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‹TransactionQueueSignDisableControllerAckProcedureArgs, void››

transfer

transfer(args: object): Promise‹TransactionQueueControllerTransferProcedureArgs, 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

Name

Type

amount

BigNumber

data?

undefined | string

from

string

reason?

undefined | string

to

string

Returns: Promise‹TransactionQueueControllerTransferProcedureArgs, void››

Last updated