Dividends
Namespace that handles all Dividend related functionality
Hierarchy
SubModule
↳ Dividends
Index
Constructors
constructor
Properties
context
securityToken
Methods
createErc20Distribution
createPolyDistribution
getDefaultExclusionList
getDistribution
getDistributions
getTaxWithholdingList
modifyDefaultExclusionList
modifyStorageWallet
modifyTaxWithholdingList
Constructors
constructor
+ new Dividends(securityToken: SecurityToken, context: Context): Dividends
Inherited from SubModule.constructor
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Returns: Dividends
Properties
Protected context
Protected context• context: Context
Inherited from SubModule.context
Protected securityToken
Protected securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Methods
createErc20Distribution
▸ createErc20Distribution(args: object): Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
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‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
createPolyDistribution
▸ createPolyDistribution(args: object): Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
Distribute dividends in POLY
Parameters:
▪ args: object
Name
Type
amount
BigNumber
checkpointId
string
excludedAddresses?
string[]
expiryDate
Date
maturityDate
Date
name
string
taxWithholdings?
Returns: Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
getDefaultExclusionList
▸ getDefaultExclusionList(): Promise‹string[]›
Retrieve the list of addresses which are excluded from receiving dividend payments by default
Returns: Promise‹string[]›
getDistribution
▸ getDistribution(args: GetDistributionParams | string): Promise‹DividendDistribution›
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[]›
Retrieve all dividend distributions at a certain checkpoint
Parameters:
▪ args: object
Name
Type
checkpointId
string
Returns: Promise‹DividendDistribution[]›
getTaxWithholdingList
▸ getTaxWithholdingList(): Promise‹TaxWithholding[]›
Retrieve a list of investor addresses and their corresponding tax withholding percentages
Returns: Promise‹TaxWithholding[]›
modifyDefaultExclusionList
▸ modifyDefaultExclusionList(args: object): Promise‹TransactionQueue‹ModifyDividendsDefaultExclusionListProcedureArgs, void››
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‹TransactionQueue‹ModifyDividendsDefaultExclusionListProcedureArgs, void››
modifyStorageWallet
▸ modifyStorageWallet(args: object): Promise‹TransactionQueue‹SetDividendsWalletProcedureArgs, void››
Change dividends storage wallet address
Parameters:
▪ args: object
Name
Type
address
string
Returns: Promise‹TransactionQueue‹SetDividendsWalletProcedureArgs, void››
modifyTaxWithholdingList
▸ modifyTaxWithholdingList(args: object): Promise‹TransactionQueue‹UpdateDividendsTaxWithholdingListProcedureArgs, void››
Set default tax withtholding list for a type of dividends
Parameters:
▪ args: object
Name
Type
taxWithholdings
Returns: Promise‹TransactionQueue‹UpdateDividendsTaxWithholdingListProcedureArgs, void››
Last updated
Was this helpful?