ControllerTransfer
Procedure that forcefully transfers Security Tokens from one account to another. Can only be executed by the Security Token's Controller
Type parameters
▪ ReturnType
Hierarchy
Procedure‹ControllerTransferProcedureArgs›
↳ ControllerTransfer
Index
Constructors
Properties
Methods
Constructors
constructor
+ new ControllerTransfer(args: ControllerTransferProcedureArgs, context: Context): ControllerTransfer
Inherited from void
Defined in src/procedures/Procedure.ts:40
Parameters:
Name | Type |
| |
|
Returns: ControllerTransfer
Properties
Protected args
Protected args• args: ControllerTransferProcedureArgs
Inherited from void
Defined in src/procedures/Procedure.ts:34
Protected context
Protected context• context: Context
Inherited from void
Defined in src/procedures/Procedure.ts:36
type
• type: ProcedureType = ProcedureType.ControllerTransfer
Overrides void
Defined in src/procedures/ControllerTransfer.ts:44
Methods
addProcedure
▸ addProcedure<A, R>(Proc: ProcedureClass‹A, R›): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:91
Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
▪ R: any
Parameters:
Name | Type | Description |
| ProcedureClass‹A, R› | A Procedure that will be run in the Procedure's TransactionQueue |
Returns: (Anonymous function)
whichever value is returned by the Procedure
addSignatureRequest
▸ addSignatureRequest<A>(request: SignatureRequest‹A›): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:179
Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
Parameters:
Name | Type | Description |
| A signature request that will be run in the Procedure's TransactionQueue |
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the signed data
addTransaction
▸ addTransaction<A, R, V>(method: LowLevelMethod‹A› | FutureLowLevelMethod‹V, A›, __namedParameters: object): (Anonymous function)
Inherited from void
Defined in src/procedures/Procedure.ts:137
Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
▪ R: any[]
▪ V: any
Parameters:
▪ method: LowLevelMethod‹A› | FutureLowLevelMethod‹V, A›
A method (or future method) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time (for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run)
▪Default value __namedParameters: object= {}
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed
prepare
▸ prepare(): Promise‹TransactionQueue‹Args, ReturnType››
Inherited from void
Defined in src/procedures/Procedure.ts:52
Mandatory method that builds a list of transactions that will be run
Returns: Promise‹TransactionQueue‹Args, ReturnType››
prepareTransactions
▸ prepareTransactions(): Promise‹void›
Overrides void
Defined in src/procedures/ControllerTransfer.ts:54
Forcefully transfer tokens from one address to another
Note this procedure will fail if:
Any of the addresses are invalid
The sender's ("from" address) balance is less than the amount being transferred
The current wallet address is not the Security Token controller address
Returns: Promise‹void›
Last updated