Dividends

Namespace that handles all Dividend related functionality

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Dividends(securityToken: SecurityToken, context: Context): Dividends

Inherited from SubModule.constructor

Defined in src/entities/SecurityToken/SubModule.ts:10

Create a new SubModule instance

Parameters:

Name

Type

securityToken

context

Returns: Dividends

Properties

Protected context

context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

Protected securityToken

securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

createErc20Distribution

createErc20Distribution(args: object): Promise‹TransactionQueueCreateDividendDistributionProcedureArgs, DividendDistribution››

Defined in src/entities/SecurityToken/Dividends.ts:79

Distribute dividends in a specified ERC20 token

Parameters:

args: object

Name

Type

amount

BigNumber

checkpointId

string

erc20Address

string

excludedAddresses?

string[]

expiryDate

Date

maturityDate

Date

name

string

taxWithholdings?

Returns: Promise‹TransactionQueueCreateDividendDistributionProcedureArgs, DividendDistribution››

createPolyDistribution

createPolyDistribution(args: object): Promise‹TransactionQueueCreateDividendDistributionProcedureArgs, DividendDistribution››

Defined in src/entities/SecurityToken/Dividends.ts:40

Distribute dividends in POLY

Parameters:

args: object

Name

Type

amount

BigNumber

checkpointId

string

excludedAddresses?

string[]

expiryDate

Date

maturityDate

Date

name

string

taxWithholdings?

Returns: Promise‹TransactionQueueCreateDividendDistributionProcedureArgs, DividendDistribution››

getDefaultExclusionList

getDefaultExclusionList(): Promise‹string[]›

Defined in src/entities/SecurityToken/Dividends.ts:278

Retrieve the list of addresses which are excluded from receiving dividend payments by default

Returns: Promise‹string[]›

getDistribution

getDistribution(args: GetDistributionParams | string): Promise‹DividendDistribution

Defined in src/entities/SecurityToken/Dividends.ts:254

Retrieve a particular dividend distribution by type and index or UUID

Parameters:

Name

Type

Description

args

dividend uuid or object containing its index

Returns: Promise‹DividendDistribution

getDistributions

getDistributions(args: object): Promise‹DividendDistribution[]›

Defined in src/entities/SecurityToken/Dividends.ts:222

Retrieve all dividend distributions at a certain checkpoint

Parameters:

args: object

Name

Type

checkpointId

string

Returns: Promise‹DividendDistribution[]›

getTaxWithholdingList

getTaxWithholdingList(): Promise‹TaxWithholding[]›

Defined in src/entities/SecurityToken/Dividends.ts:169

Retrieve a list of investor addresses and their corresponding tax withholding percentages

Returns: Promise‹TaxWithholding[]›

modifyDefaultExclusionList

modifyDefaultExclusionList(args: object): Promise‹TransactionQueueModifyDividendsDefaultExclusionListProcedureArgs, void››

Defined in src/entities/SecurityToken/Dividends.ts:152

Set default exclusion list for a type of dividends. Addresses on this list won't be considered for dividend distribution. This operation overrides the previous default exclusion list

Parameters:

args: object

Name

Type

tokenholderAddresses

string[]

Returns: Promise‹TransactionQueueModifyDividendsDefaultExclusionListProcedureArgs, void››

modifyStorageWallet

modifyStorageWallet(args: object): Promise‹TransactionQueueSetDividendsWalletProcedureArgs, void››

Defined in src/entities/SecurityToken/Dividends.ts:135

Change dividends storage wallet address

Parameters:

args: object

Name

Type

address

string

Returns: Promise‹TransactionQueueSetDividendsWalletProcedureArgs, void››

modifyTaxWithholdingList

modifyTaxWithholdingList(args: object): Promise‹TransactionQueueUpdateDividendsTaxWithholdingListProcedureArgs, void››

Defined in src/entities/SecurityToken/Dividends.ts:109

Set default tax withtholding list for a type of dividends

Parameters:

args: object

Name

Type

taxWithholdings

Returns: Promise‹TransactionQueueUpdateDividendsTaxWithholdingListProcedureArgs, void››

Last updated