Distributions
Handles all Security Token Distributions related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void

Protected parent

parent: SecurityToken
Inherited from void

Methods

configureDividendDistribution

configureDividendDistribution(args: ConfigureDividendDistributionParams, opts?: ProcedureOpts): Promise‹TransactionQueueDividendDistribution››
Create a Dividend Distribution for a subset of the Tokenholders at a certain (existing or future) Checkpoint
note required role:
    Origin Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call configureDividendDistribution.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Returns: Promise‹TransactionQueueDividendDistribution››

get

get(): Promise‹DistributionWithDetails[]›
Retrieve all Dividend Distributions associated to this Security Token, along with their details
Returns: Promise‹DistributionWithDetails[]›

getOne

getOne(args: object): Promise‹DistributionWithDetails
Retrieve a single Dividend Distribution associated to this Security Token by its ID
throws if there is no Distribution with the passed ID
Parameters:
args: object
Name
Type
id
BigNumber
Returns: Promise‹DistributionWithDetails
Last modified 26d ago