Daml.Finance.Interface.Instrument.Equity.Instrument

Interfaces

interface Instrument

An interface for a generic equity instrument.

viewtype V

  • Choice Archive

    Controller: Signatories of implementing template

    Returns: ()

    (no fields)

  • Choice DeclareDistribution

    Declare a distribution (e.g. a dividend or a rights issue) to shareholders.

    Controller: (DA.Internal.Record.getField @"issuer" (view $ toInterface @BaseInstrument.I this))

    Returns: ContractId I

    Field Type Description
    id Id Event identifier of the dividend distribution.
    description Text Description of the dividend event.
    effectiveTime Time Time at which the dividend is distributed.
    newInstrument InstrumentKey Instrument held after the dividend distribution (i.e. "ex-dividend" stock).
    perUnitDistribution [InstrumentQuantity] Distributed quantities per unit held.

  • Choice DeclareReplacement

    Declare a replacement event, where units of the instrument are replaced by a basket of other instruments.

    Controller: (DA.Internal.Record.getField @"issuer" (view $ toInterface @BaseInstrument.I this))

    Returns: ContractId I

    Field Type Description
    id Id Distribution Id.
    description Text Description of the replacement event.
    effectiveTime Time Time the replacement is to be executed.
    perUnitReplacement [InstrumentQuantity] Payout offered to shareholders per held share.

  • Choice DeclareStockSplit

    Declare a stock split.

    Controller: (DA.Internal.Record.getField @"issuer" (view $ toInterface @BaseInstrument.I this))

    Returns: ContractId I

    Field Type Description
    id Id Event identifier of the stock split.
    description Text Description of the stock split event.
    effectiveTime Time Time at which the stock split is effective.
    newInstrument InstrumentKey Instrument to be held after the stock split is executed.
    adjustmentFactor Decimal Adjustment factor for the stock split.

  • Choice GetView

    Retrieves the interface view.

    Controller: viewer

    Returns: View

    Field Type Description
    viewer Party The party retrieving the view.

  • Method declareDistribution : DeclareDistribution -> Update (ContractId I)

    Implementation for the DeclareDistribution choice.

  • Method declareReplacement : DeclareReplacement -> Update (ContractId I)

    Implementation for the DeclareReplacement choice.

  • Method declareStockSplit : DeclareStockSplit -> Update (ContractId I)

    Implementation for the DeclareStockSplit choice.

Data Types

type I

= Instrument

Type synonym for Instrument.

instance HasMethod Factory "create’" (Create -> Update (ContractId I))

type V

= View

Type synonym for View.

instance HasFromAnyView Instrument V

data View

View for Instrument.

View

Field Type Description
instrument InstrumentKey The instrument’s key.

instance Eq View

instance Show View