Polymesh SDK API Reference
v5.0.0
v5.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyXParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • distributions
  • Protected parent
  • remove
  • removeAgent
  • setAgent
  • setDefaults
  • Methods
  • getAgent
  • getDefaults

Was this helpful?

  1. Classes

CorporateActions

PreviousCorporateActionNextCount

Last updated 3 years ago

Was this helpful?

Handles all Security Token Corporate Actions related functionality

Hierarchy

  • Namespace‹›

    ↳ CorporateActions

Index

Properties

Methods

Properties

Protected context

Inherited from void

distributions

Protected parent

Inherited from void

remove

Remove a Corporate Action

note required role:

  • Corporate Actions Agent

removeAgent

• removeAgent: ProcedureMethod‹void, void›

Remove the Corporate Actions Agent of the Security Token

note this action will leave the Security Token owner as the Corporate Actions Agent

note required role:

  • Security Token Owner

setAgent

Assign a new Corporate Actions Agent for the Security Token

param identity to be set as Corporate Actions Agent

param date at which the authorization request to modify the Corporate Actions Agent expires (optional, never expires if a date is not provided)

note this may create AuthorizationRequests which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

  • Security Token Owner

setDefaults

Assign default values for targets, global tax withholding percentage and per-identity tax withholding perecentages.

note These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults

Methods

getAgent

Retrieve the Security Token's Corporate Actions agent

getDefaults

Retrieve default values for targets, global tax withholding percentage and per-identity tax withholding perecentages.

note These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults

• context:

Defined in

• distributions:

Defined in

• parent:

Defined in

• remove: ProcedureMethod‹, void›

Defined in

Defined in

• setAgent: ProcedureMethod‹, void›

Defined in

• setDefaults: ProcedureMethod‹, void›

Defined in

▸ getAgent(): Promise‹›

Defined in

Returns: Promise‹›

▸ getDefaults(): Promise‹›

Defined in

Returns: Promise‹›

Context
src/api/entities/Namespace.ts:11
Distributions
src/api/entities/SecurityToken/CorporateActions/index.ts:35
SecurityToken
src/api/entities/Namespace.ts:9
RemoveCorporateActionParams
src/api/entities/SecurityToken/CorporateActions/index.ts:109
src/api/entities/SecurityToken/CorporateActions/index.ts:101
ModifyCorporateActionsAgentParams
src/api/entities/SecurityToken/CorporateActions/index.ts:91
src/api/entities/SecurityToken/CorporateActions/index.ts:76
Identity
src/api/entities/SecurityToken/CorporateActions/index.ts:114
Identity
CorporateActionDefaults
src/api/entities/SecurityToken/CorporateActions/index.ts:146
CorporateActionDefaults
SecurityToken
context
distributions
parent
remove
removeAgent
setAgent
setDefaults
getAgent
getDefaults
ModifyCaDefaultsParams