Distributions

Handles all Security Token Distributions related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

Protected parent

parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

configureDividendDistribution

configureDividendDistribution(args: ConfigureDividendDistributionParams, opts?: ProcedureOpts): Promise‹TransactionQueueDividendDistribution››

Defined in src/api/entities/SecurityToken/CorporateActions/Distributions.ts:43

Create a Dividend Distribution for a subset of the Tokenholders at a certain (existing or future) Checkpoint

note required roles:

  • Security Token Corporate Actions Agent

  • 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[]›

Defined in src/api/entities/SecurityToken/CorporateActions/Distributions.ts:64

Retrieve all Dividend Distributions associated to this Security Token

Returns: Promise‹DistributionWithDetails[]›

Last updated