CorporateAction
Represents an action initiated by the issuer of a Security Token which may affect the positions of the Tokenholders

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

declarationDate

declarationDate: Date
date at which the Corporate Action was created

defaultTaxWithholding

defaultTaxWithholding: BigNumber
default percentage of tax withholding for this Corporate Action

description

description: string
brief text description of the Corporate Action

id

id: BigNumber
internal Corporate Action ID

Protected kind

kind: CorporateActionKind

targets

targets: CorporateActionTargets
tokenholder identities related to this Corporate action. If the treatment is Exclude, the identities are not targeted by the Action, and any identities left out of the array will be targeted, and vice versa

taxWithholdings

taxWithholdings: TaxWithholding[]
percentage of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

ticker

ticker: string
ticker of the Security Token

uuid

uuid: string
Inherited from Entity.uuid

Methods

checkpoint

checkpoint(): Promise‹Checkpoint | CheckpointSchedule | null›
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‹Checkpoint | CheckpointSchedule | null›

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Corporate Action exists on chain
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

linkDocuments

linkDocuments(args: LinkCaDocsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹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 Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

modifyCheckpoint

modifyCheckpoint(args: ModifyCaCheckpointParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹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 Current Account has the required permissions to run it
Parameters:
Name
Type
args
ModifyCaCheckpointParams
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Corporate Action's static data
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago