Class: CorporateActions
api/entities/Asset/Fungible/CorporateActions.CorporateActions
Handles all Asset Corporate Actions related functionality
Hierarchy
-
Namespace<FungibleAsset>↳
CorporateActions
Properties
distributions
• distributions: Distributions
Defined in
api/entities/Asset/Fungible/CorporateActions/index.ts:26
Methods
getAgents
▸ getAgents(): Promise<Identity[]>
Retrieve a list of agent Identities
Returns
Promise<Identity[]>
Defined in
api/entities/Asset/Fungible/CorporateActions/index.ts:74
getDefaultConfig
▸ getDefaultConfig(): Promise<CorporateActionDefaultConfig>
Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.
Returns
Promise<CorporateActionDefaultConfig>
Note
This config is applied to every Corporate Action that is created until they are modified. Modifying the default config does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override this default config
Defined in
api/entities/Asset/Fungible/CorporateActions/index.ts:110
remove
▸ remove(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Remove a Corporate Action
Parameters
| Name | Type |
|---|---|
args | RemoveCorporateActionParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Fungible/CorporateActions/index.ts:67
setDefaultConfig
▸ setDefaultConfig(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)
Parameters
| Name | Type |
|---|---|
args | ModifyCaDefaultConfigParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
These config values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these default config values
Note
this method is of type ProcedureMethod, which means you can call setDefaultConfig.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it