api.entities.Asset.CorporateActions.CorporateActions

Class: CorporateActions

api/entities/Asset/CorporateActions.CorporateActions

Handles all Asset Corporate Actions related functionality

Hierarchy

• Namespace<Asset>

  ↳ CorporateActions

Table of contents

Properties

• distributions

Methods

• getAgents
• getDefaultConfig
• remove
• removeAgent
• setAgent
• setDefaultConfig

Properties

distributions

• distributions: Distributions

Defined in

api/entities/Asset/CorporateActions/index.ts:37

Methods

getAgents

▸ getAgents(): Promise<Identity[]>

Retrieve a list of agent Identities

Returns

Promise<Identity[]>

---

getDefaultConfig

▸ getDefaultConfig(): Promise<CorporateActionDefaultConfig>

Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.

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

Returns

Promise<CorporateActionDefaultConfig>

---

remove

▸ remove(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Remove a Corporate Action

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

Parameters

Name	Type
args	RemoveCorporateActionParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

---

removeAgent

▸ removeAgent(opts?): Promise<GenericPolymeshTransaction<void, void>>

Remove the Corporate Actions Agent of the Asset

Note

this action will leave the Asset owner as the Corporate Actions Agent

Deprecated

Note

this method is of type NoArgsProcedureMethod, which means you can call removeAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

---

setAgent

▸ setAgent(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Assign a new Corporate Actions Agent for the Asset

Note

this may create Authorization Requests which have to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Deprecated

in favor of inviteAgent

Note

this method is of type ProcedureMethod, which means you can call setAgent.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
args	ModifyCorporateActionsAgentParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

---

setDefaultConfig

▸ setDefaultConfig(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)

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

Parameters

Name	Type
args	ModifyCaDefaultConfigParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>