Dividends
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all Dividend related functionality
↳ Dividends
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Protected contextProtected securityTokenDistribute 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?
Distribute dividends in POLY
Parameters:
â–ª args: object
Name
Type
amount
BigNumber
checkpointId
string
excludedAddresses?
string[]
expiryDate
Date
maturityDate
Date
name
string
taxWithholdings?
▸ getDefaultExclusionList(): Promise‹string[]›
Retrieve the list of addresses which are excluded from receiving dividend payments by default
Returns: Promise‹string[]›
Retrieve a particular dividend distribution by type and index or UUID
Parameters:
Name
Type
Description
args
dividend uuid or object containing its index
Retrieve all dividend distributions at a certain checkpoint
Parameters:
â–ª args: object
Name
Type
checkpointId
string
Retrieve a list of investor addresses and their corresponding tax withholding percentages
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[]
Change dividends storage wallet address
Parameters:
â–ª args: object
Name
Type
address
string
Set default tax withtholding list for a type of dividends
Parameters:
â–ª args: object
Name
Type
taxWithholdings
+ new Dividends(securityToken: , context: ):
Inherited from .
Defined in
Returns:
• context:
Inherited from .
Defined in
• securityToken:
Inherited from .
Defined in
▸ createErc20Distribution(args: object): Promise‹‹, ››
Defined in
[]
Returns: Promise‹‹, ››
▸ createPolyDistribution(args: object): Promise‹‹, ››
Defined in
[]
Returns: Promise‹‹, ››
Defined in
▸ getDistribution(args: | string): Promise‹›
Defined in
| string
Returns: Promise‹›
▸ getDistributions(args: object): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getTaxWithholdingList(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ modifyDefaultExclusionList(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ modifyStorageWallet(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ modifyTaxWithholdingList(args: object): Promise‹‹, void››
Defined in
[]
Returns: Promise‹‹, void››