Distributions

Handles all Security Token Distributions related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Distributions

Index

Properties

• context

• parent

Methods

• configureDividendDistribution

• get

• getOne

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‹TransactionQueue‹DividendDistribution››

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

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:

Name	Type
args	ConfigureDividendDistributionParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹DividendDistribution››

get

▸ get(): Promise‹DistributionWithDetails[]›

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

Retrieve all Dividend Distributions associated to this Security Token, along with their details

Returns: Promise‹DistributionWithDetails[]›

getOne

▸ getOne(args: object): Promise‹DistributionWithDetails›

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

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›