Abstract Class: CorporateActionBase

Defined in: src/api/entities/CorporateActionBase/index.ts:63

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

Extends

• Entity<UniqueIdentifiers, unknown>

Extended by

• CorporateAction
• CorporateBallot
• DividendDistribution

Properties

asset

asset: FungibleAsset

Defined in: src/api/entities/CorporateActionBase/index.ts:82

Asset affected by this Corporate Action

---

declarationDate

declarationDate: Date

Defined in: src/api/entities/CorporateActionBase/index.ts:87

date at which the Corporate Action was created

---

defaultTaxWithholding

defaultTaxWithholding: BigNumber

Defined in: src/api/entities/CorporateActionBase/index.ts:103

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

---

description

description: string

Defined in: src/api/entities/CorporateActionBase/index.ts:92

brief text description of the Corporate Action

---

id

id: BigNumber

Defined in: src/api/entities/CorporateActionBase/index.ts:77

internal Corporate Action ID

---

targets

targets: CorporateActionTargets

Defined in: src/api/entities/CorporateActionBase/index.ts:98

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

---

taxWithholdings

taxWithholdings: TaxWithholding[]

Defined in: src/api/entities/CorporateActionBase/index.ts:109

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

---

uuid

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from

Entity.uuid

Methods

checkpoint()

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

Defined in: src/api/entities/CorporateActionBase/index.ts:188

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 | Checkpoint | CheckpointSchedule>

---

exists()

exists(): Promise<boolean>

Defined in: src/api/entities/CorporateActionBase/index.ts:177

Determine whether this Corporate Action exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

linkDocuments()

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

Defined in: src/api/entities/CorporateActionBase/index.ts:159

Link a list of documents to this corporate action

Parameters

Parameter	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

---

modifyCheckpoint()

abstract modifyCheckpoint(args: Modify<ModifyCaCheckpointParams, { checkpoint: InputCaCheckpoint; }>, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/CorporateActionBase/index.ts:164

Modify the Corporate Action's Checkpoint

Parameters

Parameter	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

---

toHuman()

toHuman(): HumanReadable

Defined in: src/api/entities/CorporateActionBase/index.ts:274

Return the Corporate Action's static data

Returns

HumanReadable

Overrides

Entity.toHuman

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize