ToggleAllowBeneficialInvestments
Last updated
Was this helpful?
Last updated
Was this helpful?
Procedure that toggles whether beneficial investments are allowed or not in an STO
â–ª ReturnType
Procedure‹›
↳ ToggleAllowBeneficialInvestments
Inherited from void
Parameters:
Name
Type
args
context
Protected argsInherited from void
Protected contextInherited from void
Overrides void
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:
Name
Type
Description
Proc
A Procedure that will be run in the Procedure's TransactionQueue
Returns: (Anonymous function)
whichever value is returned by the Procedure
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:
Name
Type
Description
request
A signature request that will be run in the Procedure's TransactionQueue
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the signed data
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= {}
Name
Type
Default
fees
-
resolvers
object
([] as unknown) as ResolverArray
tag
-
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed
Inherited from void
Mandatory method that builds a list of transactions that will be run
▸ prepareTransactions(): Promise‹void›
Overrides void
Toggle to allow or disallow beneficial investments in the STO
Note this procedure will fail if:
Trying to allow beneficial investments when they are already allowed
Trying to disallow beneficial investments when they are already disallowed
The specified STO address is invalid
The specified STO type is invalid
The STO has not been launched, or the module has been archived
Returns: Promise‹void›
+ new ToggleAllowBeneficialInvestments(args: , context: ):
Defined in
Returns:
• args:
Defined in
• context:
Defined in
• type: = ProcedureType.ToggleAllowBeneficialInvestments
Defined in
▸ addProcedure<A, R>(Proc: ‹A, R›): (Anonymous function)
Defined in
‹A, R›
▸ addSignatureRequest<A>(request: ‹A›): (Anonymous function)
Defined in
‹A›
▸ addTransaction<A, R, V>(method: ‹A› | ‹V, A›, __namedParameters: object): (Anonymous function)
Defined in
▪ method: ‹A› | ‹V, A›
undefined |
undefined | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
▸ prepare(): Promise‹‹Args, ReturnType››
Defined in
Returns: Promise‹‹Args, ReturnType››
Defined in