@openpit/engine
    Preparing search index...

    Class ExecutionReportFillDetails

    Fill-details group: lock, fee, caller-calculated reservation remainder, last trade, and finality.

    Index
    constructor
    fee isFinal lastTrade lock remainingReservedQuantity
    [dispose] clone free

    • Constructs a fill-details group around the required lock.

      The lock is mandatory; the other fields default to absent and are set through their setters.

      Parameters

      Returns ExecutionReportFillDetails

    • get fee(): MonetaryAmount | undefined

      The fee amount and currency for this fill, or undefined.

      Returns MonetaryAmount | undefined

    • set fee(value: MonetaryAmount | MonetaryAmountInit | null | undefined): void

      Sets or clears the fee amount and currency.

      Accepts a MonetaryAmount object or a MonetaryAmountInit literal.

      Errors

      Throws ParamError/AssetError when a present value cannot be marshalled into the core value types.

      Parameters

      Returns void

    • get isFinal(): boolean | undefined

      Whether this report closes the order's report stream, or undefined.

      Returns boolean | undefined

    • set isFinal(value: boolean | null | undefined): void

      Sets the finality flag.

      Parameters

      • value: boolean | null | undefined

      Returns void

    • get lastTrade(): Trade | undefined

      The last executed trade, or undefined.

      Returns Trade | undefined

    • set lastTrade(value: Trade | TradeInit | null | undefined): void

      Sets the last executed trade (accepts a Trade object or a plain TradeInit literal).

      Errors

      Throws ParamError when value is neither a Trade nor a valid literal.

      Parameters

      Returns void

    • get lock(): Lock | undefined

      The reservation lock for this fill, or undefined when omitted from a plain object.

      Returns Lock | undefined

    • set lock(value: Lock): void

      Sets the reservation lock.

      Parameters

      Returns void

    • get remainingReservedQuantity(): Quantity | undefined

      The caller-calculated reservation remainder, or undefined.

      The engine releases this value on finalization. It is not a venue-reported remaining order quantity.

      Returns Quantity | undefined

    • set remainingReservedQuantity(
          value: string | number | bigint | Quantity | null | undefined,
      ): void

      Sets the caller-calculated reservation remainder.

      The engine releases this value on finalization. It is not a venue-reported remaining order quantity. Accepts a value object or DecimalInput.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • value: string | number | bigint | Quantity | null | undefined

      Returns void

    • Returns void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods