Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • asset
  • Protected context
  • declarationDate
  • defaultTaxWithholding
  • description
  • id
  • Protected kind
  • targets
  • taxWithholdings
  • uuid
  • Methods
  • checkpoint
  • exists
  • isEqual
  • linkDocuments
  • Abstract modifyCheckpoint
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CorporateActionBase

PreviousCorporateActionNextCorporateActions

Last updated 2 years ago

Was this helpful?

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

Hierarchy

  • ‹UniqueIdentifiers, unknown›

    ↳ CorporateActionBase

    ↳

    ↳

Index

Properties

Methods

Properties

asset

Asset affected by this Corporate Action


Protected context

• context: Context


declarationDate

• declarationDate: Date

date at which the Corporate Action was created


defaultTaxWithholding

• defaultTaxWithholding: BigNumber

default percentage (0-100) 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

type of corporate action being represented


targets

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

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


uuid

• uuid: string

Methods

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


exists

▸ exists(): Promise‹boolean›

Determine whether this Corporate Action exists on chain

Returns: Promise‹boolean›


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


linkDocuments

Link a list of documents to this corporate action

note any previous links are removed in favor of the new list

Parameters:

Name
Type

args

opts?


Abstract modifyCheckpoint

Modify the Corporate Action's Checkpoint

Parameters:

Name
Type

args

opts?


toHuman

â–¸ toHuman(): HumanReadable

Return the Corporate Action's static data

Returns: HumanReadable


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

• asset:

Defined in

Inherited from .

Defined in

Defined in

Defined in

Defined in

Defined in

• kind:

Defined in

• targets:

Defined in

• taxWithholdings: []

Defined in

Inherited from .

Defined in

▸ checkpoint(): Promise‹ | | null›

Defined in

Returns: Promise‹ | | null›

Overrides .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

▸ linkDocuments(args: , opts?: ): Promise‹‹void››

Defined in

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

Returns: Promise‹‹void››

▸ modifyCheckpoint(args: ‹ModifyCaCheckpointParams, object›, opts?: ): Promise‹‹void››

Defined in

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

‹ModifyCaCheckpointParams, object›

Returns: Promise‹‹void››

Overrides .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Asset
src/api/entities/CorporateActionBase/index.ts:77
src/api/entities/Entity.ts:48
src/api/entities/CorporateActionBase/index.ts:82
src/api/entities/CorporateActionBase/index.ts:98
src/api/entities/CorporateActionBase/index.ts:87
src/api/entities/CorporateActionBase/index.ts:72
CorporateActionKind
src/api/entities/CorporateActionBase/index.ts:109
CorporateActionTargets
src/api/entities/CorporateActionBase/index.ts:93
TaxWithholding
src/api/entities/CorporateActionBase/index.ts:104
src/api/entities/Entity.ts:46
Checkpoint
CheckpointSchedule
src/api/entities/CorporateActionBase/index.ts:183
Checkpoint
CheckpointSchedule
src/api/entities/CorporateActionBase/index.ts:172
Entity
src/api/entities/Entity.ts:61
LinkCaDocsParams
ProcedureOpts
TransactionQueue
src/api/entities/CorporateActionBase/index.ts:152
ProcedureMethod
linkDocuments.checkAuthorization
TransactionQueue
src/api/entities/CorporateActionBase/index.ts:162
ProcedureMethod
modifyCheckpoint.checkAuthorization
TransactionQueue
src/api/entities/CorporateActionBase/index.ts:262
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
CorporateAction
DividendDistribution
asset
context
declarationDate
defaultTaxWithholding
description
id
kind
targets
taxWithholdings
uuid
checkpoint
exists
isEqual
linkDocuments
modifyCheckpoint
toHuman
generateUuid
unserialize
Entity
LinkCaDocsParams
ProcedureOpts
ProcedureOpts
CheckpointSchedule
CheckpointSchedule
Entity
CheckpointSchedule
ProcedureOpts
TransactionQueue
Entity
CheckpointSchedule
CheckpointSchedule
exists
toHuman
context
uuid
isEqual
generateUuid
unserialize
Modify
Modify