DividendDistribution
Represents a Corporate Action via which a Security Token issuer wishes to distribute dividends between a subset of the Tokenholders (targets)

Hierarchy

DividendDistribution

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

currency

currency: string
ticker of the currency in which dividends are being distibuted

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
Inherited from CorporateAction.description
brief text description of the Corporate Action

expiryDate

expiryDate: null | Date
date after which dividends can no longer be paid/reclaimed. A null value means the distribution never expires

id

id: BigNumber
Inherited from CorporateAction.id
internal Corporate Action ID

Protected kind

Overrides CorporateAction.kind

maxAmount

maxAmount: BigNumber
maximum amount of currency to be distributed. Distributions are "first come, first served", so funds can be depleted before every Tokenholder receives their corresponding amount

origin

Portfolio from which the dividends will be distributed

paymentDate

paymentDate: Date
date starting from which dividends can be paid/reclaimed

perShare

perShare: BigNumber
amount of currency to pay for each share the Tokenholder holds

targets

targets: CorporateActionTargets
Inherited from CorporateAction.targets
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
Inherited from CorporateAction.ticker
ticker of the Security Token

uuid

uuid: string
Inherited from Entity.uuid

Methods

checkpoint

checkpoint(): Promise‹Checkpoint | CheckpointSchedule
Retrieve the Checkpoint associated with this Dividend Distribution. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead
Returns: Promise‹Checkpoint | CheckpointSchedule

claim

claim(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Claim the dividends corresponding to the current Identity
note this method is of type ProcedureMethod, which means you can call claim.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

details

details(): Promise‹DividendDistributionDetails
Retrieve details associated with this Dividend Distribution
Returns: Promise‹DividendDistributionDetails

exists

exists(): Promise‹boolean›
Overrides CorporateAction.exists
Retrieve whether the Distribution exists
Returns: Promise‹boolean›

getParticipant

getParticipant(args?: undefined | object): Promise‹DistributionParticipant | null›
Retrieve an Identity that is entitled to dividends in this Distribution (participant), the amount it is entitled to and whether it has been paid or not
note if the Distribution Checkpoint hasn't been created yet, the result will be null. This is because the Distribution participant's corresponding payment cannot be determined without a Checkpoint
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹DistributionParticipant | null›

getParticipants

getParticipants(): Promise‹DistributionParticipant[]›
Retrieve a comprehensive list of all Identities that are entitled to dividends in this Distribution (participants), the amount they are entitled to and whether they have been paid or not
note this request can take a lot of time with large amounts of Tokenholders
note if the Distribution Checkpoint hasn't been created yet, the result will be an empty array. This is because the Distribution participants cannot be determined without a Checkpoint
Returns: Promise‹DistributionParticipant[]›

getPaymentHistory

getPaymentHistory(opts: object): Promise‹ResultSetDistributionPayment››
Retrieve the payment history for this Distribution
note uses the middleware
note supports pagination
Parameters:
Default value opts: object= {}
Name
Type
size?
undefined | number
start?
undefined | number
Returns: Promise‹ResultSetDistributionPayment››

getWithheldTax

getWithheldTax(): Promise‹BigNumber›
Retrieve the amount of taxes that have been withheld up to this point in this Distribution
note uses the middleware
Returns: Promise‹BigNumber›

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››
Inherited from CorporateAction.linkDocuments
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: ModifyDistributionCheckpointParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Modify the Distribution'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
ModifyDistributionCheckpointParams
opts?
Returns: Promise‹TransactionQueue‹void››

pay

pay(args: PayDividendsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Transfer the corresponding share of the dividends to a list of Identities
note due to performance issues, we do not validate that the distribution has enough remaining funds to pay the corresponding amount to the supplied Identities
note this method is of type ProcedureMethod, which means you can call pay.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

reclaimFunds

reclaimFunds(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Reclaim any remaining funds back to the origin Portfolio. This can only be done after the Distribution has expired
note withheld taxes are also reclaimed in the same transaction
note required roles:
    Origin Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call reclaimFunds.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Overrides CorporateAction.toJson
Return the Dividend Distribution'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