api.entities.CorporateActionBase.CorporateActionBase

Class: CorporateActionBase

api/entities/CorporateActionBase.CorporateActionBase

Represents an action initiated by the issuer of an Asset which may affect the positions of the Asset Holders

Hierarchy

• Entity<UniqueIdentifiers, unknown>

  ↳ CorporateActionBase

  ↳↳ CorporateAction

  ↳↳ DividendDistribution

Table of contents

Properties

• asset
• declarationDate
• defaultTaxWithholding
• description
• id
• targets
• taxWithholdings
• uuid

Methods

• checkpoint
• exists
• isEqual
• linkDocuments
• modifyCheckpoint
• toHuman
• generateUuid
• unserialize

Properties

asset

• asset: FungibleAsset

Asset affected by this Corporate Action

Defined in

api/entities/CorporateActionBase/index.ts:84

---

declarationDate

• declarationDate: Date

date at which the Corporate Action was created

Defined in

api/entities/CorporateActionBase/index.ts:89

---

defaultTaxWithholding

• defaultTaxWithholding: BigNumber

default percentage (0-100) of tax withholding for this Corporate Action

Defined in

api/entities/CorporateActionBase/index.ts:105

---

description

• description: string

brief text description of the Corporate Action

Defined in

api/entities/CorporateActionBase/index.ts:94

---

id

• id: BigNumber

internal Corporate Action ID

Defined in

api/entities/CorporateActionBase/index.ts:79

---

targets

• targets: CorporateActionTargets

Asset Holder Identities related to this Corporate action. If the treatment is Exclude, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa

Defined in

api/entities/CorporateActionBase/index.ts:100

---

taxWithholdings

• taxWithholdings: TaxWithholding[]

percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

Defined in

api/entities/CorporateActionBase/index.ts:111

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

checkpoint

▸ checkpoint(): Promise<null | CheckpointSchedule | Checkpoint>

Retrieve the Checkpoint associated with this Corporate Action. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead. A null value means the Corporate Action was created without an associated Checkpoint

Returns

Promise<null | CheckpointSchedule | Checkpoint>

Defined in

api/entities/CorporateActionBase/index.ts:195

---

exists

▸ exists(): Promise<boolean>

Determine whether this Corporate Action exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/CorporateActionBase/index.ts:184

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

linkDocuments

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

Link a list of documents to this corporate action

Parameters

Name	Type
args	LinkCaDocsParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

any previous links are removed in favor of the new list

Note

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

Defined in

api/entities/CorporateActionBase/index.ts:164

---

modifyCheckpoint

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

Modify the Corporate Action's Checkpoint

Parameters

Name	Type
args	Modify<ModifyCaCheckpointParams, { checkpoint: InputCaCheckpoint }>
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

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

Defined in

api/entities/CorporateActionBase/index.ts:174

---

toHuman

▸ toHuman(): HumanReadable

Return the Corporate Action's static data

Returns

HumanReadable

Overrides

Entity.toHuman

Defined in

api/entities/CorporateActionBase/index.ts:275

---

generateUuid

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

Name	Type
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14

---

unserialize

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

Name	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23