CreateDividendDistribution
Procedure to create a Dividend Distribution on a Security Token. The funds to be distributed as dividends will come from the current user's wallet
Hierarchy
Procedure‹CreateDividendDistributionProcedureArgs, DividendDistribution›
↳ CreateDividendDistribution
Index
Constructors
Properties
Methods
Constructors
constructor
+ new CreateDividendDistribution(args
: CreateDividendDistributionProcedureArgs, context
: Context): CreateDividendDistribution
Inherited from void
Defined in src/procedures/Procedure.ts:40
Parameters:
Returns: CreateDividendDistribution
Properties
Protected
args
Protected
args• args: CreateDividendDistributionProcedureArgs
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.CreateDividendDistribution
Overrides void
Defined in src/procedures/CreateDividendDistribution.ts:27
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:
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:
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‹PostTransactionResolver‹DividendDistribution, TransactionReceiptWithDecodedLogs››
Overrides void
Defined in src/procedures/CreateDividendDistribution.ts:37
Approve spend of the amount that will be distributed
Create a Dividend Distribution for said amount
Set tax withholding percentages (if supplied)
Return the newly created Dividend Distribution
Note that this procedure will fail if the ERC20 Dividends Feature has not been enabled
Returns: Promise‹PostTransactionResolver‹DividendDistribution, TransactionReceiptWithDecodedLogs››
Last updated