Dividends
Namespace that handles all Dividend related functionality
Hierarchy
↳ Dividends
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 |
| |
|
Returns: Dividends
Properties
Protected
context
Protected
context• context: Context
Inherited from SubModule.context
Defined in src/entities/SecurityToken/SubModule.ts:10
Protected
securityToken
Protected
securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Defined in src/entities/SecurityToken/SubModule.ts:8
Methods
createErc20Distribution
▸ createErc20Distribution(args
: object): Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
Defined in src/entities/SecurityToken/Dividends.ts:79
Distribute dividends in a specified ERC20 token
Parameters:
▪ args: object
Name | Type |
| BigNumber |
| string |
| string |
| string[] |
| Date |
| Date |
| string |
|
Returns: Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
createPolyDistribution
▸ createPolyDistribution(args
: object): Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, DividendDistribution››
Defined in src/entities/SecurityToken/Dividends.ts:40
Distribute dividends in POLY
Parameters:
▪ args: object
Name | Type |
| BigNumber |
| string |
| string[] |
| Date |
| Date |
| string |
|
Returns: Promise‹TransactionQueue‹CreateDividendDistributionProcedureArgs, 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 |
| GetDistributionParams | string | 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 |
| 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‹TransactionQueue‹ModifyDividendsDefaultExclusionListProcedureArgs, 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 |
| string[] |
Returns: Promise‹TransactionQueue‹ModifyDividendsDefaultExclusionListProcedureArgs, void››
modifyStorageWallet
▸ modifyStorageWallet(args
: object): Promise‹TransactionQueue‹SetDividendsWalletProcedureArgs, void››
Defined in src/entities/SecurityToken/Dividends.ts:135
Change dividends storage wallet address
Parameters:
▪ args: object
Name | Type |
| string |
Returns: Promise‹TransactionQueue‹SetDividendsWalletProcedureArgs, void››
modifyTaxWithholdingList
▸ modifyTaxWithholdingList(args
: object): Promise‹TransactionQueue‹UpdateDividendsTaxWithholdingListProcedureArgs, void››
Defined in src/entities/SecurityToken/Dividends.ts:109
Set default tax withtholding list for a type of dividends
Parameters:
▪ args: object
Name | Type |
|
Returns: Promise‹TransactionQueue‹UpdateDividendsTaxWithholdingListProcedureArgs, void››
Last updated