Class: CorporateAction
api/entities/CorporateAction.CorporateAction
Represents an action initiated by the issuer of an Asset which may affect the positions of the Asset Holders
Hierarchy
-
↳
CorporateAction
Properties
asset
• asset: FungibleAsset
Asset affected by this Corporate Action
Inherited from
Defined in
api/entities/CorporateActionBase/index.ts:75
declarationDate
• declarationDate: Date
date at which the Corporate Action was created
Inherited from
CorporateActionBase.declarationDate
Defined in
api/entities/CorporateActionBase/index.ts:80
defaultTaxWithholding
• defaultTaxWithholding: BigNumber
default percentage (0-100) of tax withholding for this Corporate Action
Inherited from
CorporateActionBase.defaultTaxWithholding
Defined in
api/entities/CorporateActionBase/index.ts:96
description
• description: string
brief text description of the Corporate Action
Inherited from
CorporateActionBase.description
Defined in
api/entities/CorporateActionBase/index.ts:85
id
• id: BigNumber
internal Corporate Action ID
Inherited from
Defined in
api/entities/CorporateActionBase/index.ts:70
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
Inherited from
Defined in
api/entities/CorporateActionBase/index.ts:91
taxWithholdings
• taxWithholdings: TaxWithholding[]
percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
Inherited from
CorporateActionBase.taxWithholdings
Defined in
api/entities/CorporateActionBase/index.ts:102
uuid
• uuid: string
Inherited from
Defined in
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>
Inherited from
CorporateActionBase.checkpoint
Defined in
api/entities/CorporateActionBase/index.ts:181
exists
▸ exists(): Promise<boolean>
Determine whether this Corporate Action exists on chain
Returns
Promise<boolean>
Inherited from
Defined in
api/entities/CorporateActionBase/index.ts:170
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
Defined in
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
Inherited from
CorporateActionBase.linkDocuments
Defined in
api/entities/CorporateActionBase/index.ts:150
modifyCheckpoint
▸ modifyCheckpoint(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Modify the Corporate Action's Checkpoint
Parameters
| Name | Type |
|---|---|
args | ModifyCaCheckpointParams |
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
Overrides
CorporateActionBase.modifyCheckpoint
Defined in
api/entities/CorporateAction.ts:67
toHuman
▸ toHuman(): HumanReadable
Return the Corporate Action's static data
Returns
Inherited from
Defined in
api/entities/CorporateActionBase/index.ts:260
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
CorporateActionBase.generateUuid
Defined in
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
CorporateActionBase.unserialize