ControllerRedeem
Procedure that redeems (burns) Security Tokens from an account. Can only be executed by the Security Token's Controller
Type parameters
▪ ReturnType
Hierarchy
↳ ControllerRedeem
Index
Constructors
Properties
Methods
Constructors
constructor
Inherited from void
Parameters:
Properties
Protected
args
Protected
argsInherited from void
Protected
context
Protected
contextInherited from void
type
Overrides void
Methods
addProcedure
Inherited from void
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:
Returns: (Anonymous function)
whichever value is returned by the Procedure
addSignatureRequest
Inherited from void
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:
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the signed data
addTransaction
Inherited from void
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:
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
Inherited from void
Mandatory method that builds a list of transactions that will be run
prepareTransactions
▸ prepareTransactions(): Promise‹void›
Overrides void
Redeem tokens from a specific address, optionally providing a reason or extra data for the action
Note this procedure will fail if:
The "from" address is invalid
Attempting to redeem an amount of tokens greater than the account's balance
The current wallet address is not the Security Token controller address
Returns: Promise‹void›
Last updated