Skip to main content
Version: 21.0.x

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

Properties

asset

asset: Asset

Asset affected by this Corporate Action

Defined in

api/entities/CorporateActionBase/index.ts:80


declarationDate

declarationDate: Date

date at which the Corporate Action was created

Defined in

api/entities/CorporateActionBase/index.ts:85


defaultTaxWithholding

defaultTaxWithholding: BigNumber

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

Defined in

api/entities/CorporateActionBase/index.ts:101


description

description: string

brief text description of the Corporate Action

Defined in

api/entities/CorporateActionBase/index.ts:90


id

id: BigNumber

internal Corporate Action ID

Defined in

api/entities/CorporateActionBase/index.ts:75


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:96


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:107


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>


exists

exists(): Promise<boolean>

Determine whether this Corporate Action exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual


linkDocuments

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

Link a list of documents to this corporate action

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

Parameters

NameType
argsLinkCaDocsParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>


modifyCheckpoint

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

Modify the Corporate Action's Checkpoint

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

Parameters

NameType
argsModify<ModifyCaCheckpointParams, { checkpoint: InputCaCheckpoint }>
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>


toHuman

toHuman(): HumanReadable

Return the Corporate Action's static data

Returns

HumanReadable

Overrides

Entity.toHuman


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Entity.generateUuid


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize